home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 1998 November / IRIX 6.5.2 Base Documentation November 1998.img / usr / share / catman / p_man / cat3 / complib / sstebz.z / sstebz
Text File  |  1998-10-30  |  8KB  |  199 lines
  1.  
  2.  
  3.  
  4. SSSSSSSSTTTTEEEEBBBBZZZZ((((3333FFFF))))                                                          SSSSSSSSTTTTEEEEBBBBZZZZ((((3333FFFF))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      SSTEBZ - compute the eigenvalues of a symmetric tridiagonal matrix T
  10.  
  11. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  12.      SUBROUTINE SSTEBZ( RANGE, ORDER, N, VL, VU, IL, IU, ABSTOL, D, E, M,
  13.                         NSPLIT, W, IBLOCK, ISPLIT, WORK, IWORK, INFO )
  14.  
  15.          CHARACTER      ORDER, RANGE
  16.  
  17.          INTEGER        IL, INFO, IU, M, N, NSPLIT
  18.  
  19.          REAL           ABSTOL, VL, VU
  20.  
  21.          INTEGER        IBLOCK( * ), ISPLIT( * ), IWORK( * )
  22.  
  23.          REAL           D( * ), E( * ), W( * ), WORK( * )
  24.  
  25. PPPPUUUURRRRPPPPOOOOSSSSEEEE
  26.      SSTEBZ computes the eigenvalues of a symmetric tridiagonal matrix T.  The
  27.      user may ask for all eigenvalues, all eigenvalues in the half-open
  28.      interval (VL, VU], or the IL-th through IU-th eigenvalues.
  29.  
  30.      To avoid overflow, the matrix must be scaled so that its
  31.      largest element is no greater than overflow**(1/2) *
  32.      underflow**(1/4) in absolute value, and for greatest
  33.      accuracy, it should not be much smaller than that.
  34.  
  35.      See W. Kahan "Accurate Eigenvalues of a Symmetric Tridiagonal Matrix",
  36.      Report CS41, Computer Science Dept., Stanford
  37.      University, July 21, 1966.
  38.  
  39.  
  40. AAAARRRRGGGGUUUUMMMMEEEENNNNTTTTSSSS
  41.      RANGE   (input) CHARACTER
  42.              = 'A': ("All")   all eigenvalues will be found.
  43.              = 'V': ("Value") all eigenvalues in the half-open interval (VL,
  44.              VU] will be found.  = 'I': ("Index") the IL-th through IU-th
  45.              eigenvalues (of the entire matrix) will be found.
  46.  
  47.      ORDER   (input) CHARACTER
  48.              = 'B': ("By Block") the eigenvalues will be grouped by split-off
  49.              block (see IBLOCK, ISPLIT) and ordered from smallest to largest
  50.              within the block.  = 'E': ("Entire matrix") the eigenvalues for
  51.              the entire matrix will be ordered from smallest to largest.
  52.  
  53.      N       (input) INTEGER
  54.              The order of the tridiagonal matrix T.  N >= 0.
  55.  
  56.      VL      (input) REAL
  57.              VU      (input) REAL If RANGE='V', the lower and upper bounds of
  58.              the interval to be searched for eigenvalues.  Eigenvalues less
  59.              than or equal to VL, or greater than VU, will not be returned.
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. SSSSSSSSTTTTEEEEBBBBZZZZ((((3333FFFF))))                                                          SSSSSSSSTTTTEEEEBBBBZZZZ((((3333FFFF))))
  71.  
  72.  
  73.  
  74.              VL < VU.  Not referenced if RANGE = 'A' or 'I'.
  75.  
  76.      IL      (input) INTEGER
  77.              IU      (input) INTEGER If RANGE='I', the indices (in ascending
  78.              order) of the smallest and largest eigenvalues to be returned.  1
  79.              <= IL <= IU <= N, if N > 0; IL = 1 and IU = 0 if N = 0.  Not
  80.              referenced if RANGE = 'A' or 'V'.
  81.  
  82.      ABSTOL  (input) REAL
  83.              The absolute tolerance for the eigenvalues.  An eigenvalue (or
  84.              cluster) is considered to be located if it has been determined to
  85.              lie in an interval whose width is ABSTOL or less.  If ABSTOL is
  86.              less than or equal to zero, then ULP*|T| will be used, where |T|
  87.              means the 1-norm of T.
  88.  
  89.              Eigenvalues will be computed most accurately when ABSTOL is set
  90.              to twice the underflow threshold 2*SLAMCH('S'), not zero.
  91.  
  92.      D       (input) REAL array, dimension (N)
  93.              The n diagonal elements of the tridiagonal matrix T.
  94.  
  95.      E       (input) REAL array, dimension (N-1)
  96.              The (n-1) off-diagonal elements of the tridiagonal matrix T.
  97.  
  98.      M       (output) INTEGER
  99.              The actual number of eigenvalues found. 0 <= M <= N.  (See also
  100.              the description of INFO=2,3.)
  101.  
  102.      NSPLIT  (output) INTEGER
  103.              The number of diagonal blocks in the matrix T.  1 <= NSPLIT <= N.
  104.  
  105.      W       (output) REAL array, dimension (N)
  106.              On exit, the first M elements of W will contain the eigenvalues.
  107.              (SSTEBZ may use the remaining N-M elements as workspace.)
  108.  
  109.      IBLOCK  (output) INTEGER array, dimension (N)
  110.              At each row/column j where E(j) is zero or small, the matrix T is
  111.              considered to split into a block diagonal matrix.  On exit, if
  112.              INFO = 0, IBLOCK(i) specifies to which block (from 1 to the
  113.              number of blocks) the eigenvalue W(i) belongs.  (SSTEBZ may use
  114.              the remaining N-M elements as workspace.)
  115.  
  116.      ISPLIT  (output) INTEGER array, dimension (N)
  117.              The splitting points, at which T breaks up into submatrices.  The
  118.              first submatrix consists of rows/columns 1 to ISPLIT(1), the
  119.              second of rows/columns ISPLIT(1)+1 through ISPLIT(2), etc., and
  120.              the NSPLIT-th consists of rows/columns ISPLIT(NSPLIT-1)+1 through
  121.              ISPLIT(NSPLIT)=N.  (Only the first NSPLIT elements will actually
  122.              be used, but since the user cannot know a priori what value
  123.              NSPLIT will have, N words must be reserved for ISPLIT.)
  124.  
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. SSSSSSSSTTTTEEEEBBBBZZZZ((((3333FFFF))))                                                          SSSSSSSSTTTTEEEEBBBBZZZZ((((3333FFFF))))
  137.  
  138.  
  139.  
  140.      WORK    (workspace) REAL array, dimension (4*N)
  141.  
  142.      IWORK   (workspace) INTEGER array, dimension (3*N)
  143.  
  144.      INFO    (output) INTEGER
  145.              = 0:  successful exit
  146.              < 0:  if INFO = -i, the i-th argument had an illegal value
  147.              > 0:  some or all of the eigenvalues failed to converge or
  148.              were not computed:
  149.              =1 or 3: Bisection failed to converge for some eigenvalues; these
  150.              eigenvalues are flagged by a negative block number.  The effect
  151.              is that the eigenvalues may not be as accurate as the absolute
  152.              and relative tolerances.  This is generally caused by
  153.              unexpectedly inaccurate arithmetic.  =2 or 3: RANGE='I' only: Not
  154.              all of the eigenvalues
  155.              IL:IU were found.
  156.              Effect: M < IU+1-IL
  157.              Cause:  non-monotonic arithmetic, causing the Sturm sequence to
  158.              be non-monotonic.  Cure:   recalculate, using RANGE='A', and pick
  159.              out eigenvalues IL:IU.  In some cases, increasing the PARAMETER
  160.              "FUDGE" may make things work.  = 4:    RANGE='I', and the
  161.              Gershgorin interval initially used was too small.  No eigenvalues
  162.              were computed.  Probable cause: your machine has sloppy
  163.              floating-point arithmetic.  Cure: Increase the PARAMETER "FUDGE",
  164.              recompile, and try again.
  165.  
  166. PPPPAAAARRRRAAAAMMMMEEEETTTTEEEERRRRSSSS
  167.      RELFAC  REAL, default = 2.0e0
  168.              The relative tolerance.  An interval (a,b] lies within "relative
  169.              tolerance" if  b-a < RELFAC*ulp*max(|a|,|b|), where "ulp" is the
  170.              machine precision (distance from 1 to the next larger floating
  171.              point number.)
  172.  
  173.      FUDGE   REAL, default = 2
  174.              A "fudge factor" to widen the Gershgorin intervals.  Ideally, a
  175.              value of 1 should work, but on machines with sloppy arithmetic,
  176.              this needs to be larger.  The default for publicly released
  177.              versions should be large enough to handle the worst machine
  178.              around.  Note that this has no effect on accuracy of the
  179.              solution.
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.                                                                         PPPPaaaaggggeeee 3333
  196.  
  197.  
  198.  
  199.